home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2005 October / PCWOCT05.iso / Software / FromTheMag / XAMPP 1.4.14 / xampp-win32-1.4.14-installer.exe / xampp / php / pear / Structures / Graph.php
Encoding:
PHP Script  |  2004-10-01  |  5.6 KB  |  157 lines
  1. <?php
  2. /* vim: set expandtab tabstop=4 shiftwidth=4 foldmethod=marker: */
  3. // +-----------------------------------------------------------------------------+
  4. // | Copyright (c) 2003 SΘrgio Gonτalves Carvalho                                |
  5. // +-----------------------------------------------------------------------------+
  6. // | This file is part of Structures_Graph.                                      |
  7. // |                                                                             |
  8. // | Structures_Graph is free software; you can redistribute it and/or modify    |
  9. // | it under the terms of the GNU Lesser General Public License as published by |
  10. // | the Free Software Foundation; either version 2.1 of the License, or         |
  11. // | (at your option) any later version.                                         |
  12. // |                                                                             |
  13. // | Structures_Graph is distributed in the hope that it will be useful,         |
  14. // | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
  15. // | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
  16. // | GNU Lesser General Public License for more details.                         |
  17. // |                                                                             |
  18. // | You should have received a copy of the GNU Lesser General Public License    |
  19. // | along with Structures_Graph; if not, write to the Free Software             |
  20. // | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA                    |
  21. // | 02111-1307 USA                                                              |
  22. // +-----------------------------------------------------------------------------+
  23. // | Author: SΘrgio Carvalho <sergio.carvalho@portugalmail.com>                  |
  24. // +-----------------------------------------------------------------------------+
  25. //
  26. /**
  27.  * The Graph.php file contains the definition of the Structures_Graph class 
  28.  *
  29.  * @see Structures_Graph
  30.  * @package Structures_Graph
  31.  */
  32.  
  33. /* dependencies {{{ */
  34. /** PEAR base classes */
  35. require_once 'PEAR.php';
  36. /** Graph Node */
  37. require_once 'Structures/Graph/Node.php';
  38. /* }}} */
  39.  
  40. define('STRUCTURES_GRAPH_ERROR_GENERIC', 100);
  41.  
  42. /* class Structures_Graph {{{ */
  43. /**
  44.  * The Structures_Graph class represents a graph data structure. 
  45.  *
  46.  * A Graph is a data structure composed by a set of nodes, connected by arcs.
  47.  * Graphs may either be directed or undirected. In a directed graph, arcs are 
  48.  * directional, and can be traveled only one way. In an undirected graph, arcs
  49.  * are bidirectional, and can be traveled both ways.
  50.  *
  51.  * @author        SΘrgio Carvalho <sergio.carvalho@portugalmail.com> 
  52.  * @copyright    (c) 2004 by SΘrgio Carvalho
  53.  * @package Structures_Graph
  54.  */
  55. /* }}} */
  56. class Structures_Graph {
  57.     /* fields {{{ */
  58.     /**
  59.      * @access private
  60.      */
  61.     var $_nodes = array();
  62.     /**
  63.      * @access private
  64.      */
  65.     var $_directed = false;
  66.     /* }}} */
  67.  
  68.     /* Constructor {{{ */
  69.     /**
  70.     *
  71.     * Constructor
  72.     *
  73.     * @param    boolean    Set to true if the graph is directed. Set to false if it is not directed. (Optional, defaults to true)
  74.     * @access    public
  75.     */
  76.     function Structures_Graph($directed = true) {
  77.         $this->_directed = $directed;
  78.     }
  79.     /* }}} */
  80.  
  81.     /* isDirected {{{ */
  82.     /**
  83.     *
  84.     * Return true if a graph is directed
  85.     *
  86.     * @return    boolean     true if the graph is directed
  87.     * @access    public
  88.     */
  89.     function isDirected() {
  90.         return (boolean) $this->_directed;
  91.     }
  92.     /* }}} */
  93.  
  94.     /* addNode {{{ */
  95.     /**
  96.     *
  97.     * Add a Node to the Graph
  98.     *
  99.     * @param    Structures_Graph_Node   The node to be added.
  100.     * @access    public
  101.     */
  102.     function addNode(&$newNode) {
  103.         // We only add nodes
  104.         if (!is_a($newNode, 'Structures_Graph_Node')) 
  105.             Pear::raiseError('Structures_Graph::addNode received an object that is not a Structures_Graph_Node', STRUCTURES_GRAPH_ERROR_GENERIC);
  106.         // Graphs are node *sets*, so duplicates are forbidden. We allow nodes that are exactly equal, but disallow equal references.
  107.         foreach($this->_nodes as $key => $node) {
  108.             /*
  109.              ZE1 equality operators choke on the recursive cycle introduced by the _graph field in the Node object.
  110.              So, we'll check references the hard way
  111.             */
  112.             $savedData = $this->_nodes[$key];
  113.             $referenceIsEqualFlag = false;
  114.             $this->_nodes[$key] = true;
  115.             if ($node === true) {
  116.                 $this->_nodes[$key] = false;
  117.                 if ($node === false) 
  118.                     $referenceIsEqualFlag = true;
  119.             }
  120.             $this->_nodes[$key] = $savedData;
  121.             if ($referenceIsEqualFlag)
  122.                 Pear::raiseError('Structures_Graph::addNode received an object that is a duplicate for this dataset', STRUCTURES_GRAPH_ERROR_GENERIC);
  123.         }
  124.         $this->_nodes[] =& $newNode;
  125.         $newNode->setGraph($this);
  126.     }
  127.     /* }}} */
  128.  
  129.     /* removeNode (unimplemented) {{{ */
  130.     /**
  131.     *
  132.     * Remove a Node from the Graph
  133.     *
  134.     * @todo     This is unimplemented
  135.     * @param    Structures_Graph_Node   The node to be removed from the graph
  136.     * @access    public
  137.     */
  138.     function removeNode(&$node) {
  139.     }
  140.     /* }}} */
  141.  
  142.     /* getNodes {{{ */
  143.     /**
  144.     *
  145.     * Return the node set, in no particular order. For ordered node sets, use a Graph Manipulator insted.
  146.     *
  147.     * @access   public
  148.     * @see      Structures_Graph_Manipulator_TopologicalSorter
  149.     * @return   array The set of nodes in this graph
  150.     */
  151.     function &getNodes() {
  152.         return $this->_nodes;
  153.     }
  154.     /* }}} */
  155. }
  156. ?>
  157.